Draws an icon using appropriate size and depth data from an IconRef.

OSErr PlotIconRef (
    const Rect *theRect, 
    IconAlignmentType align, 
    IconTransformType transform, 
    IconServicesUsageFlags theIconServicesUsageFlags, 
    IconRef theIconRef
);

theRect

A pointer to the rectangle where the icon is to be drawn.

align

A value specifying how Icon Services should align the icon within the rectangle. For a description of possible return values, see “Icon Alignment Constants”

transform

A value specifying how Icon Services should modify the appearance of the icon.

theIconServicesUsageFlags

Reserved for future use. Pass the kIconServicesDefaultUsageFlags constant in this parameter.

theIconRef

The IconRef for the icon to draw.

function result

A result code.

DISCUSSION

This function is similar to the Icon Utilities function PlotIconSuite.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when IconServicesLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by IconServicesLib 8.5 and later.

© 2000 Apple Computer, Inc. — (Last Updated 4/18/2000)